Skip to content

build: write all docs for workspace packages#2533

Merged
zimeg merged 9 commits intomainfrom
docs
Mar 12, 2026
Merged

build: write all docs for workspace packages#2533
zimeg merged 9 commits intomainfrom
docs

Conversation

@zimeg
Copy link
Member

@zimeg zimeg commented Mar 3, 2026

Summary

This PR writes all docs for workspace packages with the following command 📚

$ npm run docs

Notes

This might be a final effort of current focus to centralizing development packages - happy to report that the following list now fits on my screen 🤓

$ npm ls

Requirements

@zimeg zimeg self-assigned this Mar 3, 2026
@zimeg zimeg requested a review from a team as a code owner March 3, 2026 23:23
@zimeg zimeg added docs M-T: Documentation work only semver:patch pkg:web-api applies to `@slack/web-api` pkg:rtm-api applies to `@slack/rtm-api` pkg:webhook applies to `@slack/webhook` pkg:logger applies to `@slack/logger` pkg:types applies to `@slack/types` pkg:oauth applies to `@slack/oauth` pkg:socket-mode applies to `@slack/socket-mode` pkg:cli-test applies to `@slack/cli-test` dependencies Pull requests that update a dependency file labels Mar 3, 2026
@changeset-bot
Copy link

changeset-bot bot commented Mar 3, 2026 •
edited
Loading

⚠️ No Changeset found

Latest commit: 46d89aa

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@codecov
Copy link

codecov bot commented Mar 3, 2026 •
edited
Loading

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 90.67%. Comparing base (98dbd4e) to head (46d89aa).
⚠️ Report is 1 commits behind head on main.
✅ All tests successful. No failed tests found.

Additional details and impacted files 
@@           Coverage Diff           @@
##             main    #2533   +/-   ##
=======================================
  Coverage   90.67%   90.67%           
=======================================
  Files          82       82           
  Lines       14994    14994           
  Branches      508      508           
=======================================
  Hits        13596    13596           
  Misses       1373     1373           
  Partials       25       25
Flag Coverage Δ
cli-hooks 90.67% <ø> (ø)
cli-test 90.67% <ø> (ø)
logger 90.67% <ø> (ø)
oauth 90.67% <ø> (ø)
socket-mode 90.67% <ø> (ø)
web-api 90.67% <ø> (ø)
webhook 90.67% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

🚀 New features to boost your workflow:
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@zimeg
Copy link
Member Author

zimeg commented Mar 3, 2026

👾 We might note this toward #2359 as well!

lukegalbraithrussell
lukegalbraithrussell approved these changes Mar 3, 2026
View reviewed changes
Copy link
Contributor

@lukegalbraithrussell lukegalbraithrussell left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

love to see this!

WilliamBergamin
WilliamBergamin approved these changes Mar 4, 2026
View reviewed changes
Copy link
Contributor

@WilliamBergamin WilliamBergamin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice work 💯 left one comment on the claude settings, not a blocker

Base automatically changed from tsconfig to main March 12, 2026 23:16
zimeg added 3 commits March 12, 2026 16:17
@zimeg
chore: claude remove typescript blog
4810679
@zimeg
Merge remote-tracking branch 'origin/main' into docs
1f349a9 
# Conflicts:
#	package.json
#	packages/cli-test/package.json
#	packages/logger/package.json
#	packages/oauth/package.json
#	packages/rtm-api/package.json
#	packages/socket-mode/package.json
#	packages/types/package.json
#	packages/web-api/package.json
#	packages/webhook/package.json
@zimeg
revert: coauthored by claude
46d89aa
@zimeg
Copy link
Member Author

zimeg commented Mar 12, 2026

@lukegalbraithrussell @WilliamBergamin Let's get this merged and run this toward the next release in adjacent PR for now #2530 📚

@zimeg zimeg merged commit 9b23414 into main Mar 12, 2026
10 checks passed
@zimeg zimeg deleted the docs branch March 12, 2026 23:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@WilliamBergamin WilliamBergamin WilliamBergamin approved these changes

@lukegalbraithrussell lukegalbraithrussell lukegalbraithrussell approved these changes

Assignees

@zimeg zimeg

Labels

dependencies Pull requests that update a dependency file docs M-T: Documentation work only pkg:cli-test applies to `@slack/cli-test` pkg:logger applies to `@slack/logger` pkg:oauth applies to `@slack/oauth` pkg:rtm-api applies to `@slack/rtm-api` pkg:socket-mode applies to `@slack/socket-mode` pkg:types applies to `@slack/types` pkg:web-api applies to `@slack/web-api` pkg:webhook applies to `@slack/webhook` semver:patch

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@zimeg @WilliamBergamin @lukegalbraithrussell